DescribeCriteria
Description
call DescribeCriteria to obtain fuzzy matching query conditions for asset attributes that can be displayed when querying assets.
Request Method
POST
Request Path
/apsara/route/Sas/DescribeCriteria
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| MachineTypes | BODY | string | No | ecs | the asset type of the query. ecs : Indicates the filter criteria for querying all ECS servers. cloud_product : indicates the filter criteria for querying all other cloud products. |
| Value | BODY | string | No | xxx | the incoming value to obtain fuzzy matching filter. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| CriteriaList | array | No sample value for this parameter. | list of attribute criteria for asset query. |
| Type | string | input | the type of query condition. input: input item. Manual input is required. select: select item. You need to select from the drop-down box. |
| RequestId | string | 3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2 | request ID of the result. |
| Values | string | NO,YES,UNKNOWN | the value of the selection item when the query condition type is the selection item. when the query condition is the input item, the return value of this parameter is empty. |
| Name | string | riskStatus | the asset attribute name corresponding to this query condition. |
Example
Successful Response example
{
"CriteriaList":"",
"Type":"input",
"RequestId":"3F6E4741-6CE6-47CA-80E8-CF5CB145DBE2",
"Values":"NO,
YES,
UNKNOWN",
"Name":"riskStatus"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}